﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once

#include "GcmpModelInterface.h"
#include "IObject.h"
#include "Vector3d.h"

namespace gcmp {

    
    class IElement;
    class IGraphicsNode;
    class IDocument;
    /// \brief 对象的移动上下文的接口。
    class GCMP_MODEL_INTERFACE_EXPORT IElementMoveContext : public IObject
    {
        DEFINE_CAST_DERIVED(gcmp::IElementMoveContext, gcmp::IObject);
    public:
        /// \brief 创建单个对象移动的上下文。
        /// \param pDocument 当前文档
        /// \param moveElemId 移动对象的Id
        /// \param moveVector 移动向量
        /// \return 返回一个接口的指针。
        static OwnerPtr<IElementMoveContext> CreateElementMoveContext(IDocument* pDocument, ElementId moveElementIds, const Vector3d& moveVector);

        /// \brief 创建多个对象移动的上下文。
        /// \param pDocument 当前文档
        /// \param moveElementIds 所有移动对象的Id
        /// \param moveVector 移动向量
        /// \return 返回一个接口的指针。
        static OwnerPtr<IElementMoveContext> CreateElementMoveContext(IDocument* pDocument, const std::vector<ElementId>& moveElementIds, const Vector3d& moveVector);

        /// \brief 创建多个对象移动的上下文。
        /// \param pDocument 当前文档
        /// \param moveElementIds 所有移动对象的Id
        /// \param moveVector 移动向量
        /// \return 返回一个接口的指针。
        static OwnerPtr<IElementMoveContext> CreateElementMoveContext(IDocument* pDocument, const UnorderedElementIdSet& moveElementIds, const Vector3d& moveVector);

        /// \brief 获取当前文档。
        /// \return 返回一个文档的接口指针。
        virtual IDocument* GetDocument() const = 0;

        /// \brief 对象是不是正在被移动。
        /// \param elementId 要判断的对象
        /// \return 如果对象正在被移动，返回true；否则返回false。
        virtual bool IsMoveElementId(ElementId elementId) const = 0;

        /// \brief 获取移动向量。
        /// \return 返回移动向量。
        virtual const Vector3d& GetMoveVector() const = 0;

        /// \brief 设置移动向量。
        /// \param moveVector 移动向量。
        virtual void SetMoveVector(const Vector3d& moveVector) = 0;

        /// \brief 获取移动向量起点位置。
        /// \return 返回移动向量起点位置。
        virtual const Vector3d& GetOriginPosition() const = 0;

        /// \brief 设置移动向量起点位置。
        /// \param originPosition 移动向量起点位置。
        virtual void SetOriginPosition(const Vector3d& originPosition) = 0;

        /// \brief 获取被移动对象。
        /// \return 返回所有被移动的对象Id。
        virtual const UnorderedElementIdSet& GetMoveElementIds() const = 0;
    };

}// namespace gcmp


